<?php ob_start('ob_gzhandler') ?>
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <!--
        /**
        * o------------------------------------------------------------------------------o
        * | This file is part of the RGraph package - you can learn more at:             |
        * |                                                                              |
        * |                          http://www.rgraph.net                               |
        * |                                                                              |
        * | This package is licensed under the RGraph license. For all kinds of business |
        * | purposes there is a small one-time licensing fee to pay and for non          |
        * | commercial  purposes it is free to use. You can read the full license here:  |
        * |                                                                              |
        * |                      http://www.rgraph.net/LICENSE.txt                       |
        * o------------------------------------------------------------------------------o
        */
    -->
    <title>RGraph: HTML5 canvas graph library - horizontal bar chart documentation</title>

    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
    <link rel="icon" type="image/png" href="/favicon.png">
</head>
<body>
    <div id="breadcrumb">
        <a href="../index.html">RGraph: HTML5 canvas graph library</a>
        >
        <a href="index.html">Documentation</a>
        >
        Horizontal bar chart
    </div>

    <h1>RGraph: HTML5 canvas graph library - Horizontal bar chart documentation</h1>

    <script>
        if (document.all) {
            document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer does not natively support the HTML5 canvas tag yet, so if you want to see the graphs, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul></div>');
        }
    </script>

    <p>
        The horizontal bar graph is minor variation on the bar chart which can be useful when you have larger labels, since you have
        more space available to you for them.
    </p>
    
    <p>
        The example file is <a href="../examples/hbar.html">here</a>.
    </p>
    
    <pre class="code">
&lt;script&gt;
    window.onload = function ()
    {
        var data = [280,45,133,166,84,259,266,960,219,311];
    
        var hbar = new RGraph.HBar('myCanvas', data);
        hbar.Set('chart.labels', ['Richard', 'Alex', 'Nick', 'Scott', 'Kjnell', 'Doug', 'Charles', 'Michelle', 'Mark', 'Alison']);
        hbar.Set('chart.gutter', 45);
        hbar.Set('chart.background.barcolor1', 'rgba(255,255,255,1)');
        hbar.Set('chart.background.barcolor2', 'rgba(255,255,255,1)');
        hbar.Set('chart.background.grid', true);
        hbar.Set('chart.colors', ['rgba(255,0,0,1)']);
        hbar.Draw();
    }
&lt;/script&gt;
</pre>

    <!--
        <PROPERTIES>
            chart.gutter :: The gutter of the graph. This is the area outside of the X and Y axis - where the labels go. If you're short on space for your labels, try increasing this. <br /><i>Default: 25</i>
            chart.colors :: An array of the colors of the actual bars. <br /><i>Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']</i>
            chart.background.barcolor1 :: The color of the background bars, (1 of 2). <br /><i>Default: white</i>
            chart.background.barcolor2 :: The color of the background bars, (2 of 2). <br /><i>Default: white</i>
            chart.background.grid :: Whether to show the background grid or not. <br /><i>Default: true</i>
            chart.background.grid.color :: The color of the background grid. <br /><i>Default: #ddd</i>
            chart.background.grid.hsize :: The horizontal background grid size. <br /><i>Default: 40</i>
            chart.background.grid.vsize :: The vertical background grid size. <br /><i>Default: 18</i>
            chart.background.grid.width :: The width that the background grid lines are. Decimals (eg 0.5) are permitted.<br /><i>Default: 0.5</i>
            chart.background.grid.border :: Determines whether a border line is drawn around the grid.<br /><i>Default: true</i>
            chart.background.grid.hlines :: Determines whether to draw the horizontal grid lines.<br /><i>Default: true</i>
            chart.background.grid.vlines :: Determines whether to draw the vertical grid lines.<br /><i>Default: true</i>
            chart.labels :: An array of the labels to be used on the graph. <br /><i>Default: An empty array</i>
            chart.labels.above :: This is a boolean which if true, will cause labels to be shown to the right of the bars. (It's called "above" for API compatibility).<br /><i>Default: false</i>
            chart.text.font :: The font used to render the text.<br /><i>Default: Verdana</i>
            chart.text.color :: The color of the labels. <br /><i>Default: black</i>
            chart.text.size :: The size (in points) of the labels. <br /><i>Default: 10</i>
            chart.title :: The title of the graph, if any. <br /><i>Default: null</i>
            chart.title.vpos :: This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i>
            chart.title.color :: The color of the title.<br /> <i>Default: black</i>
            chart.xmax :: (Optional) An optional max figure for the X scale.<br /> <i>Default: none (one is calculated)</i>
            chart.axis.color :: The color of the axes.<br /> <i>Default: black</i>
            chart.grouping :: How the bars are grouped, and it should be one of: <b>grouped</b> or <b>stacked</b><br /><i>Default: grouped</i>
            chart.shadow :: Whether a small drop shadow is applied. <br /><i>Default: false</i>
            chart.shadow.color :: The color of the shadow. <br /><i>Default: #666</i>
            chart.shadow.offsetx :: The X offset of the shadow. <br /><i>Default: 3</i>
            chart.shadow.offsety :: The Y offset of the shadow. <br /><i>Default: 3</i>
            chart.shadow.blur :: The severity of the shadow blurring effect. <br /><i>Default: 3</i>
            chart.yaxispos :: The position of the Y axis. Works with regular and grouped charts. Can be either <i>center</i> or <i>left</i>.<br /> <i>Default: left</i>
            chart.key :: An array of key information. <br /><i>Default: [] (An empty array)</i>
            chart.key.background :: The color of the key background. Typically white, you could set this to something like rgba(255,255,255,0.7) to allow people to see things behind it.<br /><i>Default: white</i>
            chart.key.position :: Determines the position of the key.Either <b>graph</b> (default), or <b>gutter</b>.<br /><i>Default: graph</i>
            chart.key.shadow :: Whether a small drop shadow is applied to the key.<br /><i>Default: false</i>
            chart.contextmenu :: An array of context menu items. You cannot have context menus AND tooltips, only one or the other. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i>
            chart.units.pre :: The units that the X axis is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".<br /><i>Default: none</i>
            chart.units.post :: The units that the X axis is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".<br /><i>Default: none</i>
            chart.vmargin :: The vertical margin that is applied to each individual bar.<br /><i>Default: 3</i>
            chart.strokestyle :: The color of the outlines of the bars.<br /><i>Default: black</i>
            chart.tooltips :: An array of tooltips for the chart.<br /><i>Default: An empty array</i>
            chart.tooltip.effect :: The visual effect used when showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i>
            chart.annotatable :: Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i>
            chart.annotate.color :: If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i>
            chart.zoom.mode :: Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i>
            chart.zoom.factor :: This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i>
            chart.zoom.fade.in :: Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.fade.out :: Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.hdir :: The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i>
            chart.zoom.vdir :: The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i>
            chart.zoom.delay :: The delay (in milliseconds) between frames.<br /><i>Default: 50</i>
            chart.zoom.frames :: The number of frames in the zoom animation.<br /><i>Default: 10</i>
            chart.zoom.shadow :: Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i>
            chart.zoom.thumbnail.width :: When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.thumbnail.height :: When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.background :: Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i>
        </PROPERTIES>
    -->

    <h2>Available properties</h2>
    
    <p>
        You can use these properties to control how the bar graph apears. You can set them by using the Set() method. Eg:
    </p>
    
    <p>
        <b>myHBar.Set('name', 'value');</b>
    </p>

    <!-- DOCS -->

    <table border="0" id="docs">
        <tr>
            <th><a name="chart.gutter"></a>chart.gutter</th>
            <td>The gutter of the graph. This is the area outside of the X and Y axis - where the labels go. If you're short on space for your labels, try increasing this. <br /><i>Default: 25</i></td>
            <th><a name="chart.colors"></a>chart.colors</th>
            <td>An array of the colors of the actual bars. <br /><i>Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']</i></td>
        </tr>
        <tr>
            <th><a name="chart.background.barcolor1"></a>chart.background.barcolor1</th>
            <td>The color of the background bars, (1 of 2). <br /><i>Default: white</i></td>
            <th><a name="chart.background.barcolor2"></a>chart.background.barcolor2</th>
            <td>The color of the background bars, (2 of 2). <br /><i>Default: white</i></td>
        </tr>
        <tr>
            <th><a name="chart.background.grid"></a>chart.background.grid</th>
            <td>Whether to show the background grid or not. <br /><i>Default: true</i></td>
            <th><a name="chart.background.grid.color"></a>chart.background.grid.color</th>
            <td>The color of the background grid. <br /><i>Default: #ddd</i></td>
        </tr>
        <tr>
            <th><a name="chart.background.grid.hsize"></a>chart.background.grid.hsize</th>
            <td>The horizontal background grid size. <br /><i>Default: 40</i></td>
            <th><a name="chart.background.grid.vsize"></a>chart.background.grid.vsize</th>
            <td>The vertical background grid size. <br /><i>Default: 18</i></td>
        </tr>
        <tr>
            <th><a name="chart.background.grid.width"></a>chart.background.grid.width</th>
            <td>The width that the background grid lines are. Decimals (eg 0.5) are permitted.<br /><i>Default: 0.5</i></td>
            <th><a name="chart.background.grid.border"></a>chart.background.grid.border</th>
            <td>Determines whether a border line is drawn around the grid.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.background.grid.hlines"></a>chart.background.grid.hlines</th>
            <td>Determines whether to draw the horizontal grid lines.<br /><i>Default: true</i></td>
            <th><a name="chart.background.grid.vlines"></a>chart.background.grid.vlines</th>
            <td>Determines whether to draw the vertical grid lines.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.labels"></a>chart.labels</th>
            <td>An array of the labels to be used on the graph. <br /><i>Default: An empty array</i></td>
            <th><a name="chart.labels.above"></a>chart.labels.above</th>
            <td>This is a boolean which if true, will cause labels to be shown to the right of the bars. (It's called "above" for API compatibility).<br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.font"></a>chart.text.font</th>
            <td>The font used to render the text.<br /><i>Default: Verdana</i></td>
            <th><a name="chart.text.color"></a>chart.text.color</th>
            <td>The color of the labels. <br /><i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.size"></a>chart.text.size</th>
            <td>The size (in points) of the labels. <br /><i>Default: 10</i></td>
            <th><a name="chart.title"></a>chart.title</th>
            <td>The title of the graph, if any. <br /><i>Default: null</i></td>
        </tr>
        <tr>
            <th><a name="chart.title.vpos"></a>chart.title.vpos</th>
            <td>This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i></td>
            <th><a name="chart.title.color"></a>chart.title.color</th>
            <td>The color of the title.<br /> <i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.xmax"></a>chart.xmax</th>
            <td>(Optional) An optional max figure for the X scale.<br /> <i>Default: none (one is calculated)</i></td>
            <th><a name="chart.axis.color"></a>chart.axis.color</th>
            <td>The color of the axes.<br /> <i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.grouping"></a>chart.grouping</th>
            <td>How the bars are grouped, and it should be one of: <b>grouped</b> or <b>stacked</b><br /><i>Default: grouped</i></td>
            <th><a name="chart.shadow"></a>chart.shadow</th>
            <td>Whether a small drop shadow is applied. <br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.color"></a>chart.shadow.color</th>
            <td>The color of the shadow. <br /><i>Default: #666</i></td>
            <th><a name="chart.shadow.offsetx"></a>chart.shadow.offsetx</th>
            <td>The X offset of the shadow. <br /><i>Default: 3</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.offsety"></a>chart.shadow.offsety</th>
            <td>The Y offset of the shadow. <br /><i>Default: 3</i></td>
            <th><a name="chart.shadow.blur"></a>chart.shadow.blur</th>
            <td>The severity of the shadow blurring effect. <br /><i>Default: 3</i></td>
        </tr>
        <tr>
            <th><a name="chart.yaxispos"></a>chart.yaxispos</th>
            <td>The position of the Y axis. Works with regular and grouped charts. Can be either <i>center</i> or <i>left</i>.<br /> <i>Default: left</i></td>
            <th><a name="chart.key"></a>chart.key</th>
            <td>An array of key information. <br /><i>Default: [] (An empty array)</i></td>
        </tr>
        <tr>
            <th><a name="chart.key.background"></a>chart.key.background</th>
            <td>The color of the key background. Typically white, you could set this to something like rgba(255,255,255,0.7) to allow people to see things behind it.<br /><i>Default: white</i></td>
            <th><a name="chart.key.position"></a>chart.key.position</th>
            <td>Determines the position of the key.Either <b>graph</b> (default), or <b>gutter</b>.<br /><i>Default: graph</i></td>
        </tr>
        <tr>
            <th><a name="chart.key.shadow"></a>chart.key.shadow</th>
            <td>Whether a small drop shadow is applied to the key.<br /><i>Default: false</i></td>
            <th><a name="chart.contextmenu"></a>chart.contextmenu</th>
            <td>An array of context menu items. You cannot have context menus AND tooltips, only one or the other. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i></td>
        </tr>
        <tr>
            <th><a name="chart.units.pre"></a>chart.units.pre</th>
            <td>The units that the X axis is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".<br /><i>Default: none</i></td>
            <th><a name="chart.units.post"></a>chart.units.post</th>
            <td>The units that the X axis is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".<br /><i>Default: none</i></td>
        </tr>
        <tr>
            <th><a name="chart.vmargin"></a>chart.vmargin</th>
            <td>The vertical margin that is applied to each individual bar.<br /><i>Default: 3</i></td>
            <th><a name="chart.strokestyle"></a>chart.strokestyle</th>
            <td>The color of the outlines of the bars.<br /><i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.tooltips"></a>chart.tooltips</th>
            <td>An array of tooltips for the chart.<br /><i>Default: An empty array</i></td>
            <th><a name="chart.tooltip.effect"></a>chart.tooltip.effect</th>
            <td>The visual effect used when showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i></td>
        </tr>
        <tr>
            <th><a name="chart.annotatable"></a>chart.annotatable</th>
            <td>Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i></td>
            <th><a name="chart.annotate.color"></a>chart.annotate.color</th>
            <td>If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.mode"></a>chart.zoom.mode</th>
            <td>Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i></td>
            <th><a name="chart.zoom.factor"></a>chart.zoom.factor</th>
            <td>This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.fade.in"></a>chart.zoom.fade.in</th>
            <td>Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
            <th><a name="chart.zoom.fade.out"></a>chart.zoom.fade.out</th>
            <td>Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.hdir"></a>chart.zoom.hdir</th>
            <td>The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i></td>
            <th><a name="chart.zoom.vdir"></a>chart.zoom.vdir</th>
            <td>The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.delay"></a>chart.zoom.delay</th>
            <td>The delay (in milliseconds) between frames.<br /><i>Default: 50</i></td>
            <th><a name="chart.zoom.frames"></a>chart.zoom.frames</th>
            <td>The number of frames in the zoom animation.<br /><i>Default: 10</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.shadow"></a>chart.zoom.shadow</th>
            <td>Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i></td>
            <th><a name="chart.zoom.thumbnail.width"></a>chart.zoom.thumbnail.width</th>
            <td>When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.thumbnail.height"></a>chart.zoom.thumbnail.height</th>
            <td>When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
            <th><a name="chart.zoom.background"></a>chart.zoom.background</th>
            <td>Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i></td>
        </tr>
        <tr>
        </tr>
    </table><br /><br />

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</body>
</html>